home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / transmission / web / javascript / torrent.js < prev    next >
Encoding:
JavaScript  |  2009-03-30  |  17.3 KB  |  590 lines
  1. /*
  2.  *    Copyright ¬© Dave Perrett and Malcolm Jarvis
  3.  *    This code is licensed under the GPL version 2.
  4.  *    For details, see http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
  5.  *
  6.  *    Class Torrent
  7.  */
  8.  
  9. function Torrent(controller,data) {
  10.     this.initialize(controller,data);
  11. } 
  12.  
  13. // Constants
  14. Torrent._StatusWaitingToCheck  = 1;
  15. Torrent._StatusChecking        = 2;
  16. Torrent._StatusDownloading     = 4;
  17. Torrent._StatusSeeding         = 8;
  18. Torrent._StatusPaused          = 16;
  19. Torrent._InfiniteTimeRemaining = 215784000; // 999 Hours - may as well be infinite
  20.  
  21. Torrent.prototype =
  22. {
  23.     /*
  24.      * Constructor
  25.      */
  26.     initialize: function(controller,data)
  27.     {
  28.         // Create a new <li> element
  29.         var element = $('<li/>');
  30.         element.addClass('torrent');
  31.         element[0].id = 'torrent_' + data.id;
  32.         element._torrent = this;
  33.         this._element = element;
  34.         this._controller = controller;
  35.         controller._rows.push( element );
  36.         
  37.         // Create the 'name' <div>
  38.         var e = $('<div/>');
  39.         e.addClass('torrent_name');
  40.         element.append( e );
  41.         element._name_container = e;
  42.         
  43.         // Create the 'progress details' <div>
  44.         e = $('<div/>');
  45.         e.addClass('torrent_progress_details');
  46.         element.append(e);
  47.         element._progress_details_container = e;
  48.  
  49.         // Create the 'in progress' bar
  50.         e = $('<div/>');
  51.         e.addClass('torrent_progress_bar incomplete');
  52.         e.css('width', '0%');
  53.         element.append( e );
  54.         element._progress_complete_container = e;
  55.             
  56.         // Create the 'incomplete' bar (initially hidden)
  57.         e = $('<div/>');
  58.         e.addClass('torrent_progress_bar incomplete');
  59.         e.hide();
  60.         element.append( e );
  61.         element._progress_incomplete_container = e;
  62.         
  63.         // Add the pause/resume button - don't specify the
  64.         // image or alt text until the 'refresh()' function
  65.         // (depends on torrent state)
  66.         var image = $('<div/>');
  67.         image.addClass('torrent_pause');
  68.         e = $('<a/>');
  69.         e.append( image );
  70.         element.append( e );
  71.         element._pause_resume_button_image = image;
  72.         element._pause_resume_button = e;
  73.         if (!iPhone) e.bind('click', {element: element}, this.clickPauseResumeButton);
  74.         
  75.         // Create the 'peer details' <div>
  76.         e = $('<div/>');
  77.         e.addClass('torrent_peer_details');
  78.         element.append( e );
  79.         element._peer_details_container = e;
  80.             
  81.         // Set the torrent click observer
  82.         element.bind('click', {element: element}, this.clickTorrent);
  83.         if (!iPhone) element.bind('contextmenu', {element: element}, this.rightClickTorrent);        
  84.         
  85.         // Safari hack - first torrent needs to be moved down for some reason. Seems to be ok when
  86.         // using <li>'s in straight html, but adding through the DOM gets a bit odd.
  87.         if ($.browser.safari)
  88.             this._element.css('margin-top', '7px');
  89.         
  90.         // insert the element
  91.         $('#torrent_list').append(this._element);
  92.         
  93.         // Update all the labels etc
  94.         this.refresh(data);
  95.     },
  96.  
  97.  
  98.     /*--------------------------------------------
  99.      * 
  100.      *  S E T T E R S   /   G E T T E R S
  101.      * 
  102.      *--------------------------------------------*/
  103.     
  104.     /* Return the DOM element for this torrent (a <LI> element) */
  105.     element: function() {
  106.         return this._element;
  107.     },
  108.  
  109.     setElement: function( element ) {
  110.         this._element = element;
  111.         element._torrent = this;
  112.         this.refreshHTML( );
  113.     },
  114.  
  115.     activity: function() { return this._download_speed + this._upload_speed; },
  116.     comment: function() { return this._comment; },
  117.     completed: function() { return this._completed; },
  118.     creator: function() { return this._creator; },
  119.     dateAdded: function() { return this._date; },
  120.     downloadSpeed: function() { return this._download_speed; },
  121.     downloadTotal: function() { return this._download_total; },
  122.     errorMessage: function() { return this._error_message; },
  123.     hash: function() { return this._hashString; },
  124.     id: function() { return this._id; },
  125.     isActive: function() { return this.state() != Torrent._StatusPaused; },
  126.     isDownloading: function() { return this.state() == Torrent._StatusDownloading; },
  127.     isSeeding: function() { return this.state() == Torrent._StatusSeeding; },
  128.     name: function() { return this._name; },
  129.     peersSendingToUs: function() { return this._peers_sending_to_us; },
  130.     peersGettingFromUs: function() { return this._peers_getting_from_us; },
  131.     getPercentDone: function() {
  132.         if( !this._sizeWhenDone ) return 1.0;
  133.         if( !this._leftUntilDone ) return 1.0;
  134.         return ( this._sizeWhenDone - this._leftUntilDone )
  135.                / this._sizeWhenDone;
  136.     },
  137.     getPercentDoneStr: function() {
  138.         return Math.ratio( 100 * ( this._sizeWhenDone - this._leftUntilDone ),
  139.                                    this._sizeWhenDone );
  140.     },
  141.     size: function() { return this._size; },
  142.     state: function() { return this._state; },
  143.     stateStr: function() {
  144.         switch( this.state() ) {
  145.             case Torrent._StatusSeeding:        return 'Seeding';
  146.             case Torrent._StatusDownloading:    return 'Downloading';
  147.             case Torrent._StatusPaused:         return 'Paused';
  148.             case Torrent._StatusChecking:       return 'Verifying local data';
  149.             case Torrent._StatusWaitingToCheck: return 'Waiting to verify';
  150.             default:                            return 'error';
  151.         }
  152.     },
  153.     swarmSpeed: function() { return this._swarm_speed; },
  154.     totalLeechers: function() { return this._total_leechers; },
  155.     totalSeeders: function() { return this._total_seeders; },
  156.     uploadSpeed: function() { return this._upload_speed; },
  157.     uploadTotal: function() { return this._upload_total; },
  158.  
  159.     /*--------------------------------------------
  160.      * 
  161.      *  E V E N T   F U N C T I O N S
  162.      * 
  163.      *--------------------------------------------*/
  164.     
  165.     /*
  166.      * Process a right-click event on this torrent
  167.      */
  168.     rightClickTorrent: function(event)
  169.     {
  170.         // don't stop the event! need it for the right-click menu
  171.         
  172.         var t = event.data.element._torrent;
  173.         if ( !t.isSelected( ) )
  174.             t._controller.setSelectedTorrent( t );
  175.     },
  176.     
  177.     /*
  178.      * Process a click event on this torrent
  179.      */
  180.     clickTorrent: function( event )
  181.     {
  182.         // Prevents click carrying to parent element
  183.         // which deselects all on click
  184.         event.stopPropagation();
  185.         var torrent = event.data.element._torrent;
  186.         
  187.         // 'Apple' button emulation on PC :
  188.         // Need settable meta-key and ctrl-key variables for mac emulation
  189.         var meta_key = event.metaKey
  190.         var ctrl_key = event.ctrlKey
  191.         if (event.ctrlKey && navigator.appVersion.toLowerCase().indexOf("mac") == -1) {
  192.             meta_key = true;
  193.             ctrl_key = false;
  194.         }
  195.         
  196.         // Shift-Click - Highlight a range between this torrent and the last-clicked torrent
  197.         if (iPhone) {
  198.             torrent._controller.setSelectedTorrent( torrent, true );
  199.         
  200.         } else if (event.shiftKey) {
  201.             torrent._controller.selectRange( torrent, true );
  202.             // Need to deselect any selected text
  203.             window.focus();
  204.         
  205.         // Apple-Click, not selected
  206.         } else if (!torrent.isSelected() && meta_key) {
  207.             torrent._controller.selectTorrent( torrent, true );
  208.             
  209.         // Regular Click, not selected
  210.         } else if (!torrent.isSelected()) {
  211.             torrent._controller.setSelectedTorrent( torrent, true );
  212.         
  213.         // Apple-Click, selected    
  214.         } else if (torrent.isSelected() && meta_key) {
  215.             torrent._controller.deselectTorrent( torrent, true );
  216.             
  217.         // Regular Click, selected
  218.         } else if (torrent.isSelected()) {
  219.             torrent._controller.setSelectedTorrent( torrent, true );
  220.         }
  221.         
  222.         torrent._controller.setLastTorrentClicked(torrent);
  223.     },
  224.  
  225.     /*
  226.      * Process a click event on the pause/resume button
  227.      */
  228.     clickPauseResumeButton: function( event )
  229.     {
  230.         // prevent click event resulting in selection of torrent
  231.         event.stopPropagation();
  232.  
  233.         // either stop or start the torrent
  234.         var torrent = event.data.element._torrent;
  235.         if( torrent.isActive( ) )
  236.             torrent._controller.stopTorrent( torrent );
  237.         else
  238.             torrent._controller.startTorrent( torrent );
  239.     },
  240.  
  241.     /*--------------------------------------------
  242.      * 
  243.      *  I N T E R F A C E   F U N C T I O N S
  244.      * 
  245.      *--------------------------------------------*/
  246.     
  247.     refresh: function(data) {
  248.         this.refreshData( data );
  249.         this.refreshHTML( );
  250.     },
  251.  
  252.     /*
  253.      * Refresh display
  254.      */
  255.     refreshData: function(data)
  256.     {
  257.         // These variables never change after the inital load
  258.         if (data.isPrivate)     this._is_private    = data.isPrivate;
  259.         if (data.hashString)    this._hashString    = data.hashString;
  260.         if (data.addedDate)     this._date          = data.addedDate;
  261.         if (data.totalSize)     this._size          = data.totalSize;
  262.         if (data.announceURL)   this._tracker       = data.announceURL;
  263.         if (data.comment)       this._comment       = data.comment;
  264.         if (data.creator)       this._creator       = data.creator;
  265.         if (data.dateCreated)   this._creator_date  = data.dateCreated;
  266.                 if (data.leftUntilDone) this._leftUntilDone = data.leftUntilDone;
  267.                 if (data.sizeWhenDone)  this._sizeWhenDone  = data.sizeWhenDone;
  268.         if (data.path)          this._torrent_file  = data.path;//FIXME
  269.         if (data.name) {
  270.             this._name = data.name;
  271.             this._name_lc = this._name.toLowerCase( );
  272.         }
  273.         
  274.         // Set the regularly-changing torrent variables
  275.         this._id                    = data.id;
  276.         this._completed             = data.haveUnchecked + data.haveValid;
  277.         this._verified              = data.haveValid;
  278.         this._download_total        = data.downloadedEver;
  279.         this._upload_total          = data.uploadedEver;
  280.         this._download_speed        = data.rateDownload;
  281.         this._upload_speed          = data.rateUpload;
  282.         this._peers_connected       = data.peersConnected;
  283.         this._peers_getting_from_us = data.peersGettingFromUs;
  284.         this._peers_sending_to_us   = data.peersSendingToUs;
  285.         this._error                 = data.error;
  286.         this._error_message         = data.errorString;
  287.         this._eta                   = data.eta;
  288.         this._swarm_speed           = data.swarmSpeed;
  289.         this._total_leechers        = Math.max( 0, data.leechers );
  290.         this._total_seeders         = Math.max( 0, data.seeders );
  291.         this._state                 = data.status;
  292.     },
  293.  
  294.     refreshHTML: function()
  295.     {
  296.         var progress_details;
  297.         var peer_details;
  298.         var root = this._element;
  299.         var MaxBarWidth = 100; // reduce this to make the progress bar shorter (%)
  300.         
  301.         setInnerHTML( root._name_container[0], this._name );
  302.         
  303.         // Add the progress bar
  304.                 var notDone = this._leftUntilDone > 0;
  305.  
  306.         // Fix for situation
  307.         // when a verifying/downloading torrent gets state seeding
  308.         if( this._state == Torrent._StatusSeeding )
  309.             notDone = false ;
  310.         
  311.         if( notDone )
  312.         {
  313.             var eta = '';
  314.             
  315.             if( this.isActive( ) )
  316.             {
  317.                 eta = '-';
  318.                 if (this._eta < 0 || this._eta >= Torrent._InfiniteTimeRemaining )
  319.                     eta += 'remaining time unknown';
  320.                 else
  321.                     eta += Math.formatSeconds(this._eta) + ' remaining';
  322.             }
  323.             
  324.             // Create the 'progress details' label
  325.             // Eg: '101 MB of 631 MB (16.02%) - 2 hr remaining'
  326.             progress_details = Math.formatBytes( this._sizeWhenDone - this._leftUntilDone )
  327.                              + ' of '
  328.                              + Math.formatBytes( this._sizeWhenDone )
  329.                              + ' ('
  330.                              + this.getPercentDoneStr()
  331.                              + '%)'
  332.                              + eta;
  333.         
  334.             // Figure out the percent completed
  335.             var css_completed_width = Math.floor( this.getPercentDone() * MaxBarWidth );
  336.             
  337.             // Update the 'in progress' bar
  338.             var class_name = this.isActive() ? 'in_progress' : 'incomplete_stopped';
  339.             var e = root._progress_complete_container;
  340.             e.removeClass( );
  341.             e.addClass( 'torrent_progress_bar' );
  342.             e.addClass( class_name );
  343.             e.css( 'width', css_completed_width + '%' );
  344.             if(css_completed_width == 0) { e.addClass( 'empty' ); }
  345.             
  346.             // Update the 'incomplete' bar
  347.             e = root._progress_incomplete_container;
  348.             if( !e.is('.incomplete')) {
  349.                 e.removeClass();
  350.                 e.addClass('torrent_progress_bar in_progress');
  351.             }
  352.             e.css('width', (MaxBarWidth - css_completed_width) + '%');
  353.             e.show();
  354.             
  355.             // Create the 'peer details' label
  356.             // Eg: 'Downloading from 36 of 40 peers - DL: 60.2 KB/s UL: 4.3 KB/s'
  357.             if( !this.isDownloading( ) )
  358.                 peer_details = this.stateStr( );
  359.             else {
  360.                 peer_details = 'Downloading from '
  361.                              + this.peersSendingToUs()
  362.                              + ' of '
  363.                              + this._peers_connected
  364.                              + ' peers - DL: '
  365.                              + Math.formatBytes(this._download_speed)
  366.                              + '/s UL: '
  367.                              + Math.formatBytes(this._upload_speed)
  368.                              + '/s';
  369.             }
  370.             
  371.         }
  372.         else
  373.         {
  374.             // Update the 'in progress' bar
  375.             var class_name = (this.isActive()) ? 'complete' : 'complete_stopped';
  376.             var e = root._progress_complete_container;
  377.             e.removeClass();
  378.             e.addClass('torrent_progress_bar ' + class_name );
  379.             
  380.             // Create the 'progress details' label
  381.             // Eg: '698.05 MB, uploaded 8.59 GB (Ratio: 12.3)'
  382.             progress_details = Math.formatBytes( this._size )
  383.                              + ', uploaded '
  384.                              + Math.formatBytes( this._upload_total )
  385.                              + ' (Ratio '
  386.                              + Math.ratio( this._upload_total, this._download_total )
  387.                              + ')';
  388.             
  389.             // Hide the 'incomplete' bar
  390.             root._progress_incomplete_container.hide();
  391.             
  392.             // Set progress to maximum
  393.             root._progress_complete_container.css('width', MaxBarWidth + '%');
  394.             
  395.             // Create the 'peer details' label
  396.             // Eg: 'Seeding to 13 of 22 peers - UL: 36.2 KB/s'
  397.             if( !this.isSeeding( ) )
  398.                 peer_details = this.stateStr( );
  399.             else
  400.                 peer_details = 'Seeding to '
  401.                              + this.peersGettingFromUs()
  402.                              + ' of '
  403.                              + this._peers_connected
  404.                              + ' peers - UL: '
  405.                              + Math.formatBytes(this._upload_speed)
  406.                              + '/s';
  407.         }
  408.         
  409.         // Update the progress details
  410.         setInnerHTML( root._progress_details_container[0], progress_details );
  411.         
  412.         // Update the peer details and pause/resume button
  413.         e = root._pause_resume_button_image[0];
  414.         if ( this.state() == Torrent._StatusPaused ) {
  415.             e.alt = 'Resume';
  416.             e.className = "torrent_resume";
  417.         } else {
  418.             e.alt = 'Pause';
  419.             e.className = "torrent_pause";
  420.         }
  421.         
  422.         if( this._error_message &&
  423.             this._error_message != '' &&
  424.             this._error_message != 'other' ) {
  425.             peer_details = this._error_message;
  426.         }
  427.         
  428.         setInnerHTML( root._peer_details_container[0], peer_details );
  429.     },
  430.  
  431.     /*
  432.      * Return true if this torrent is selected
  433.      */
  434.     isSelected: function() {
  435.         var e = this.element( );
  436.         return e && $.className.has( e[0], 'selected' );
  437.     },
  438.  
  439.     /**
  440.      * @param filter one of Prefs._Filter*
  441.      * @param search substring to look for, or null
  442.      * @return true if it passes the test, false if it fails
  443.      */
  444.     test: function( filter, search )
  445.     {
  446.         var pass = false;
  447.         
  448.         switch( filter )
  449.         {
  450.             case Prefs._FilterSeeding:
  451.                 pass = this.isSeeding();
  452.                 break;
  453.             case Prefs._FilterDownloading:
  454.                 pass = this.isDownloading();
  455.                 break;
  456.             case Prefs._FilterPaused:
  457.                 pass = !this.isActive();
  458.                 break;
  459.             default:
  460.                 pass = true;
  461.                 break;
  462.         }
  463.         
  464.         if( !pass )
  465.             return false;
  466.         
  467.         if( !search || !search.length )
  468.             return pass;
  469.         
  470.         var pos = this._name_lc.indexOf( search.toLowerCase() );
  471.         pass = pos != -1;
  472.         return pass;
  473.     }
  474. };
  475.  
  476. /** Helper function for Torrent.sortTorrents(). */
  477. Torrent.compareById = function( a, b ) {
  478.     return a.id() - b.id();
  479. };
  480.  
  481. /** Helper function for sortTorrents(). */
  482. Torrent.compareByAge = function( a, b ) {
  483.     return a.dateAdded() - b.dateAdded();
  484. };
  485.  
  486. /** Helper function for sortTorrents(). */
  487. Torrent.compareByName = function( a, b ) {
  488.     return a._name_lc.compareTo( b._name_lc );
  489. };
  490.  
  491. /** Helper function for sortTorrents(). */
  492. Torrent.compareByTracker = function( a, b ) {
  493.     return a._tracker.compareTo( b._tracker );
  494. };
  495.  
  496. /** Helper function for sortTorrents(). */
  497. Torrent.compareByState = function( a, b ) {
  498.     return a.state() - b.state();
  499. };
  500.  
  501. /** Helper function for sortTorrents(). */
  502. Torrent.compareByActivity = function( a, b ) {
  503.     return a.activity() - b.activity();
  504. };
  505.  
  506. /** Helper function for sortTorrents(). */
  507. Torrent.compareByProgress = function( a, b ) {
  508.     if( a.getPercentDone() !== b.getPercentDone() )
  509.         return a.getPercentDone() - b.getPercentDone();
  510.     var a_ratio = Math.ratio( a._upload_total, a._download_total );
  511.     var b_ratio = Math.ratio( b._upload_total, b._download_total );
  512.     return a_ratio - b_ratio;
  513. }
  514.  
  515. /**
  516.  * @param torrents an array of Torrent objects
  517.  * @param sortMethod one of Prefs._SortBy*
  518.  * @param sortDirection Prefs._SortAscending or Prefs._SortDescending
  519.  */
  520. Torrent.sortTorrents = function( torrents, sortMethod, sortDirection )
  521. {
  522.     switch( sortMethod )
  523.     {
  524.         case Prefs._SortByActivity:
  525.             torrents.sort( this.compareByActivity );
  526.             break;
  527.         case Prefs._SortByAge:
  528.             torrents.sort( this.compareByAge );
  529.             break;
  530.         case Prefs._SortByQueue:
  531.             torrents.sort( this.compareById );
  532.             break;
  533.         case Prefs._SortByProgress:
  534.             torrents.sort( this.compareByProgress );
  535.             break;
  536.         case Prefs._SortByState:
  537.             torrents.sort( this.compareByState );
  538.             break;
  539.         case Prefs._SortByTracker:
  540.             torrents.sort( this.compareByTracker );
  541.             break;
  542.         case Prefs._SortByName:
  543.             torrents.sort( this.compareByName );
  544.             break;
  545.         default:
  546.             console.warn( "unknown sort method: " + sortMethod );
  547.             break;
  548.     }
  549.     
  550.     if( sortDirection == Prefs._SortDescending )
  551.         torrents.reverse( );
  552.     
  553.     return torrents;
  554. };
  555.  
  556. /**
  557.  * @brief fast binary search to find a torrent
  558.  * @param torrents an array of torrents sorted by Id
  559.  * @param id the id to search for
  560.  * @return the index, or -1
  561.  */
  562. Torrent.indexOf = function( torrents, id )
  563. {
  564.     var low = 0;
  565.     var high = torrents.length;
  566.     while( low < high ) {
  567.         var mid = Math.floor( ( low + high ) / 2 );
  568.         if( torrents[mid].id() < id )
  569.             low = mid + 1;
  570.         else
  571.             high = mid;
  572.     }
  573.     if( ( low < torrents.length ) && ( torrents[low].id() == id ) ) {
  574.         return low;
  575.     } else {
  576.         return -1; // not found
  577.     }
  578. };
  579.  
  580. /**
  581.  * @param torrents an array of torrents sorted by Id
  582.  * @param id the id to search for
  583.  * @return the torrent, or null
  584.  */
  585. Torrent.lookup = function( torrents, id )
  586. {
  587.     var pos = Torrent.indexOf( torrents, id );
  588.     return pos >= 0 ? torrents[pos] : null;
  589. };
  590.